home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / ocs_door.zip / OCSDOOR.DOC < prev    next >
Text File  |  1992-02-19  |  11KB  |  286 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                      OCS-DOOR
  8.  
  9.                                      Online Classified  Service Viewing Door
  10.  
  11.                                      Written By:
  12.                                      Gary Pickett
  13.  
  14.                                      Program Written By:
  15.                                      Gary Pickett
  16.  
  17.                                      Version 1.1
  18.                                      Feb. 1992
  19.  
  20.  
  21.  
  22.  
  23. Scope
  24. ______________________________________________________________________________
  25.  
  26.     This Door allows a user to view the Online Classified Service's Ads.
  27.     The name and full path to the text files are stored in a data
  28.     file so there is no need to move any of the files to a different directory.
  29.     OCS-Door also has sysop definable menus that can be created using any
  30.     ANSI/ASCII editor. OCS-Door supports up to 99 catagories. Multiple data
  31.     files and menus can be used by calling different .CNF files. 
  32.  
  33.  
  34. History
  35. ______________________________________________________________________________
  36.  
  37.     After seeing the Online Classified Service ads and thinking what 
  38.     a great idea JJ Heim came up with, I felt that viewing the Ads through  
  39.     a door would be a major plus for his service..
  40.  
  41.     So I broke out the ol' 'C' compiler and came up with the OCS-DOOR!
  42.    
  43.  
  44.  
  45.  
  46.  
  47. How to set up the OCS-DOOR
  48. ______________________________________________________________________________
  49.  
  50.  
  51.                SYSOP SETUP AND FUNCTIONS
  52.                -------------------------
  53.  
  54.  
  55.  
  56.    Door programs  written with the GAPCDR Door Interface Module will
  57.    run on  GAP Communications  version 4  and  greater  and  on  PCB
  58.    version 14+  and greater, and most BBS' that will use the "DOOR.SYS"
  59.    standard.
  60.  
  61.    To configure the door for a particular BBS setup, a configuration
  62.    file must  be used.   At the very minimum, this file will contain
  63.    two lines.   It  may contain  more than  two,  depending  upon  a
  64.    particular doors  configuration requirements.   The  name of  the
  65.    file is  usually the  same as that of the door program but with a
  66.    CNF extension.   The  minimum requirements  for OCS-Door  are  as
  67.    follows:
  68.  
  69.  
  70.    Line 1: C:\GAP          --- Path to your default BBS directory
  71.    Line 2: Network XXIII   --- The name of your BBS
  72.    Line 3: 0               --- 0 = GAP; 1 = PC
  73.    Line 4: 4               --- Comm port IRQ
  74.    Line 5: 03F8            --- Comm port base I/O address
  75.    Line 6: 2               --- Number of catagories to view
  76.    Line 7: OCSMENU         --- Name of the menu you want to use
  77.    Line 8: OCS.DAT         --- Name of the data file your using
  78.  
  79.     Line numbers 1 - 5 are  defined by the GAPCDR library and are
  80.   self-explanitory.
  81.  
  82.     Line 6 contains the total number of catagories which will be shown
  83.   on the menu.   This number should also match the number of
  84.   entries in the data file (line 8).
  85.  
  86.     Line 7 defines the name of the  ASCII menu screen.  This name
  87.   should be seven  characters long with  no extension.  This file
  88.   will be shown if the user is not using color. If a user has the
  89.   color enabled, a menu with the same name plus "G" will be shown
  90.   if it is available.   In the example given above, a filename of
  91.   MENUG would be given to the ANSI color version of the menu.
  92.  
  93.  
  94.     The menu file should contain the list of catagories that will
  95.   be available from the door. These selections should be numbered
  96.   1 through the number of files available.   The menu should also
  97.   define three other selections, [T] for Toggle color mode, [G]
  98.   for Good-Bye to log off the BBS from the door, and  a  [Q] to 
  99.   Quit from the door and return to the BBS.
  100.  
  101.     Line 8 contains the name of the data file.      The data file
  102.   contains the full path and name to the OCS files listed in the
  103.   menu.  The Files MUST be listed in the same order as your menu.
  104.  
  105.     The last line of the  door data file should contain the entry
  106.   "9999", without the quotes.  This line is used to designate the
  107.   end of the list.
  108.  
  109.  
  110.  GAPCDR  will  obtain the  sysop's name  from  the  DOOR.SYS  door
  111.  file.
  112.  
  113.  You must  now create a batch file to invoke the door.  This batch
  114.  file is  placed in your BBS default directory.  Such a batch file
  115.  might look like this:
  116.  
  117.   ECHO OFF
  118.   C:
  119.   CD\GAP\DOORS\OCSDOOR
  120.   OCSDOOR OCSDOOR.CNF
  121.   CD \GAP
  122.   ECHO ON
  123.  
  124.  
  125.  As you  can see, the door is invoked by passing the configuration
  126.  file name as a parameter.
  127.  
  128.  You will  also need  to modify your doors menu files and the data
  129.  file that  tells the  BBS what  your doors  are and  the security
  130.  level needed to access them.  For GAP, these are respectively:
  131.  
  132.          DOORM
  133.          DOORMG
  134.          DOORS.DAT
  135.  
  136.  
  137.  
  138.  Please refer  to your  BBS documentation  for details on  setting
  139.  these files up.
  140.  
  141.  If you  are running  multi-nodes, simply  create a  separate door
  142.  configuration file for each node, and number them.  For instance,
  143.  for a  3 node  system, you might have the following configuration
  144.  files:
  145.  
  146.           OCSDOOR1.CNF
  147.           OCSDOOR2.CNF
  148.           OSCDOOR3.CNF
  149.  
  150.  The only difference between the three would be the 1st line which
  151.  points to the default directory for the particular node.
  152.  
  153.  Multi-user operation  is automatic.   For  GAP, the  presence  of
  154.  DUMMYLOK.DAT in the MAIN directory triggers multi-user operation.
  155.  For PCB, this information is derived from the PCBOARD.DAT file.
  156.  
  157.  The following  files are  read during  door initialization.  They
  158.  must be present or the door will not operate.
  159.  
  160.            GAP                      PCB
  161.          ----------------         ----------------
  162.            DOOR.SYS                 PCBOARD.SYS
  163.            GAPBBS.CNF               PCBOARD.DAT
  164.                                     USERS
  165.  
  166.  
  167.  The default mode of operation for any door that is developed with
  168.  GAPCDR is  the GAP  mode.   To run  the door under a PCB BBS, you
  169.  must set  line 3 of the door configuration file to a 1. For a GAP
  170.  system, set this line to 0.
  171.  
  172.  
  173.  
  174.  The following sysop functions are available while awaiting
  175.  keyboard input :
  176.  
  177.               F5        -  Shell to DOS.
  178.               F8        -  Twit user and return to BBS.
  179.               F10       -  Initiate chat with user.
  180.               CF10      -  Answer user page bell.
  181.               Home      -  Main user stats.
  182.               End       -  Displays sysop keys available.
  183.               PgDn      -  Secondary user stats.
  184.               Up Arrow  -  Increase user's time remaining.
  185.               Dn Arrow  -  Decrease user's time remaining.
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  One of  the nicer  features about using the TWIT key, is the user
  193.  is not  told that  "the sysop  wants them  to return to the BBS".
  194.  Instead, a very plain and simple message of "returning you to the
  195.  BBS" is  displayed.   This way,  the user  is given no indication
  196.  that the sysop is hovering about.
  197.  
  198.  When using  the F5  shell to  DOS key,  to  return  to  the  door
  199.  program, simply  type EXIT  at the DOS command prompt.  It is not
  200.  necessary to  change directories  back  to  the  door  directory.
  201.  GAPCDR is smart enough to know which drive and directory the door
  202.  program is  in and  will reset the defaults upon return from DOS.
  203.  In addition, the status line will remain "glued" to the screen.
  204.  
  205.  It should  be noted  that the  GAPCDR status line is protected by
  206.  intercepting BIOS  video calls.  If you use ANSI.SYS replacements
  207.  which write  directly to  the  video,  you  will  not  have  this
  208.  protection and your status line will scroll off the screen.
  209.  
  210.  The Up  and Down Arrow keys increase and decrease the user's time
  211.  respectively by  5 minutes for each press of the key. There is no
  212.  indication of  what is  occurring (except  by the fact the user's
  213.  time remaining  will change), so the sysop should try not to have
  214.  a lead  finger.  The increase or decrease is effective only while
  215.  the user  is in  the door.   
  216.  
  217.  
  218.  
  219.  
  220. Copyright/License/Warranty
  221. ______________________________________________________________________________
  222.  
  223.  
  224.     This document and the program file OCSDOOR.EXE ("the software")
  225.     are copyrighted by the author.  The copyright owner hereby
  226.     licenses you to use the software given these restrictions:
  227.  
  228.      o  the program shall be supplied in its original, unmodified
  229.         form, which includes this documentation;
  230.  
  231.      o  the program may not be included - or bundled - with other
  232.         goods or services.  Exceptions may be granted upon individual
  233.         request only.
  234.  
  235.      o  no fee is charged; an exception is granted to not-for-
  236.         profit users' groups, which are permitted to charge a small
  237.         fee (not to exceed $6) for materials, handling, postage,
  238.         and general overhead.  No other organization is permitted
  239.         to charge any amount for distribution of copies of the
  240.         software or documentation, or to include copies of the
  241.         software or documentation with sales of their own products.
  242.  
  243.     There is no warranty of any kind.  The copyright owner may not be
  244.     held liable for any damages, including any lost profits or other
  245.     incidental or consequential damages arising out of or inability to
  246.     use the software.  By using the software, you agree to this.
  247.  
  248.     The software and documentation is Copyright (C) 1992 by
  249.  
  250.             Gary Pickett
  251.             Santa Barbara, CA 93111
  252.    
  253.     Online Classified Service Ads are Copyright (C) 1992 by
  254.  
  255.           The Online Classified Service.   All Rights  Reserved.
  256.  
  257. The Online Classified Service;  5766 South Lansing Court, Englewood, CO 80111.
  258. Editor:  JJ  Heim,  Voice  Phone:  (303)220-8161.   BBS:  The  Rocky  Mountain
  259. DATApark, Modem: (303)290-0980.  Current  Advertising Rates  As of This Issue:
  260. $.50/line  x  number of weeks  x  ad sections.  Distribution: 6pm (MST) Sunday
  261. Evening.  Suggestion, comments, questions are welcome!
  262. ******************************************************************************
  263.  
  264.  
  265.  
  266. Registration/etc.
  267. ______________________________________________________________________________
  268.  
  269.     Registration for OCS-DOOR is FREE!   
  270.  
  271.     One of the best things you can do is give us a call and let us know
  272.     how you like OCS-DOOR and where you got it from.
  273.  
  274.     We can be reached at Network XXIII Bulletin Board at the following
  275.     numbers:
  276.  
  277.     Node 1   (805) 962-0122  HST  24-hour bulletin board
  278.     Node 2   (805) 962-0963  HST  24-hour bulletin board
  279.     Node 3   (805) 962-1206  V.32 24-hour bulletin board
  280.  
  281. ______________________________________________________________________________
  282.  
  283.  
  284.  
  285.  
  286.